﻿<?xml version="1.0" encoding="utf-8" ?>
<helpItems xmlns="http://msh" schema="maml">
  <command:command 
    xmlns:maml="http://schemas.microsoft.com/maml/2004/10"
    xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"
    xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">

    <!-- Cmdlet details section-->
    
    <command:details>
      <command:name>Disable-Tenant</command:name>
      <maml:description>
        <maml:para>Disables an Orchard tenant.</maml:para>
      </maml:description>
      <maml:copyright>
        <maml:para></maml:para>
      </maml:copyright>
      <command:verb>Diable</command:verb>
      <command:noun>Tenant</command:noun>
      <dev:version></dev:version>
    </command:details>

    <!-- Cmdlet description section-->
    
    <maml:description>
      <maml:para>The Disable-Tenant cmdlet disables a running Orchard tenant.</maml:para>
    </maml:description>

    <!-- Cmdlet syntax section-->
    
    <command:syntax>
      
      <command:syntaxItem>
        <maml:name>Disable-Tenant</maml:name>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1">
          <maml:name>Name</maml:name>
          <maml:description>
            <maml:para>Specifies the name of the tenant to disable.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">string</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
      
      <command:syntaxItem>
        <maml:name>Disable-Tenant</maml:name>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="1">
          <maml:name>Tenant</maml:name>
          <maml:description>
            <maml:para>Specifies the object which represents the Orchard tenant to disable. This object can be acquired by using the Get-ChildItem cmdlet on the Orchard PSDrive contents or by using the Get-Tenant cmdlet. This parameter is required.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">OrchardTenant</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
      
    </command:syntax>

    <!-- Cmdlet parameters section-->
    
    <command:parameters>
      
      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1">
        <maml:name>Name</maml:name>
        <maml:description>
          <maml:para>Specifies the name of the tenant to disable. This parameter is required.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">string</command:parameterValue>
        <dev:type>
          <maml:name>string</maml:name>
          <maml:uri/>
        </dev:type>
        <dev:defaultValue></dev:defaultValue>
      </command:parameter>

      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true" position="1">
        <maml:name>Tenant</maml:name>
        <maml:description>
          <maml:para>Specifies the object which represents the Orchard tenant to disable. This object can be acquired by using the Get-ChildItem cmdlet on the Orchard PSDrive contents or by using the Get-Tenant cmdlet. This parameter is required.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">OrchardTenant</command:parameterValue>
        <dev:type>
          <maml:name>OrchardTenant</maml:name>
          <maml:uri/>
        </dev:type>
        <dev:defaultValue></dev:defaultValue>
      </command:parameter>
      
    </command:parameters>

    <!-- Input - Output section-->
    
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>Proligence.PowerShell.Tenants.Items.OrchardTenant</maml:name>
          <maml:uri/>
          <maml:description />
        </dev:type>
        <maml:description>
          <maml:para>You can pipe instances of the OrchardTenant class to Disable-Tenant. This object can be acquired by using the Get-ChildItem cmdlet on the Orchard PSDrive contents or by using the Get-Tenant cmdlet.</maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>

    <command:returnValues />

    <!-- Error section-->
    
    <command:terminatingErrors />
    <command:nonTerminatingErrors />

    <!-- Notes section  -->

    <maml:alertSet>
      <maml:title></maml:title>
      <maml:alert>
        <maml:para>If the specified tenant is already disabled, the cmdlet has no effect.</maml:para>
        <maml:para>The default tenant cannot be disabled.</maml:para>
        <maml:para />
      </maml:alert>
    </maml:alertSet>

    <!-- Example section  -->
    
    <command:examples>
      
      <command:example>
        <maml:title>
          -------------------------- EXAMPLE 1 --------------------------
        </maml:title>
        <maml:introduction>
          <maml:para>Orchard:\&gt;</maml:para>
        </maml:introduction>
        <dev:code>
          Disable-Tenant foo
        </dev:code>
        <dev:remarks>
          <maml:para>Description</maml:para>
          <maml:para>-----------</maml:para>
          <maml:para>This command disables the Orchard tenant named 'foo'.</maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText></command:commandText>
          </command:commandLine>
        </command:commandLines>
      </command:example>

      <command:example>
        <maml:title>
          -------------------------- EXAMPLE 2 --------------------------
        </maml:title>
        <maml:introduction>
          <maml:para>Orchard:\&gt;</maml:para>
        </maml:introduction>
        <dev:code>
          Get-Tenant -Enabled | Disable-Tenant
        </dev:code>
        <dev:remarks>
          <maml:para>Description</maml:para>
          <maml:para>-----------</maml:para>
          <maml:para>This command disables all Orchard tenants that are currently enabled.</maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText></command:commandText>
          </command:commandLine>
        </command:commandLines>
      </command:example>
      
    </command:examples>

    <!-- Related links section  -->

    <RelatedLinks>
      <navigationLink>
        <linkText>Enable-Tenant</linkText>
        <linkText>Get-Tenant</linkText>
        <linkText>Get-ChildItem</linkText>
        <uri/>
      </navigationLink>
    </RelatedLinks>

  </command:command>
</helpItems>